The NHibernate designer supports XML documentation comments for most common elements. To view or edit documentation, right-click and choose Documentation. This displays a Documentation tool window which tracks the selection.
The exact documentation entries available depend on the selected item: for example, an association has documentation entries for each end. In general, however, documentation is broken down into three sections:
- Summary: brief text about the element (will be enclosed in a <summary> tag)
- Remarks: additional information about the element (will be enclosed in a <remarks> tag)
- Additional (XML): raw XML documentation. If you enter anything here, you must supply the documentation tags yourself. This could be used if you need to provide <example> or <exception> tags, or anything else which is not appropriate to the <summary> or <remarks> tags.
